<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<!-- saved from url=(0013)about:internet -->
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" xmlns:xlink="http://www.w3.org/1999/xlink" pref:renderer="mathplayer-dl">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <style xmlns="" type="text/css">
    /* This style sets a margin around the entire page */
        html, body {
            margin: 10px;
        }

        p {
            font: normal 16px verdana, sans-serif;
            margin: 0;
            padding-bottom:12px;
        }

        h1 {
            font: bold 25px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        h2 {
            font: bold 19px verdana, sans-serif;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0; 
            padding-bottom: 0;
        }

        h3 {
            font: bold 19px verdana, sans-serif !important;
            margin-top: 28px;
            margin-bottom: 3px;
            padding-top: 0;
            padding-bottom: 0;
        }

        li {
            font: normal 16px verdana, sans-serif;
            margin-top: 0;
            margin-bottom: 18px;
            padding-top: 0;
            padding-bottom: 0;
        }

        .pdparam {
            font: italic 16px verdana, sans-serif;
        }
		
		.term {
			font: italic 16px verdana, sans-serif;
			font-weight: normal;
		}	
		
		.type {
			font: normal 16px verdana, sans-serif !important;
		}			
		
		.parameter { 
			font-style: italic; 
			}

        a:link, a:visited {
            color: blue;
            text-decoration: none;
            font: normal 16px;
        }

        a:hover {
            background-color: #FFFF99;
            font: normal 16px;
        }

        div.funcsynopsis {
            text-align: left;
            background-color: #e6e6e6;
            font: normal 16px verdana, sans-serif;
			padding-top: 10px;
			padding-bottom: 10px;
        }

        div.funcsynopsis table {
            border-collapse: separate;
            font: normal 16px verdana, sans-serif;
        }

        div.funcsynopsis td {
            background-color: #e6e6e6;
            border: 0 solid #000;
            padding: 1px;
            font: normal 16px verdana, sans-serif;
        }

        div.refsect1 {
            font-family: verdana, sans-serif;
            font-size: 16px;
        }

        code.constant {
            font: normal 16px courier new, monospace !important;
        }
		
		span.errorname {
            font: normal 16px verdana, sans-serif !important;
        }

        code.function {
            font: bold 16px verdana, sans-serif !important;
        }
		
        b.fsfunc {
            font: bold 16px verdana, sans-serif !important;
        }
		
        code.varname {
            font: italic 16px verdana, sans-serif;
        }

        code.replaceable {
            font: italic 16px courier new, monospace;
        }

        code.funcdef {
            font: normal 16px verdana, sans-serif !important;
        }

        .citerefentry {
            font: normal 16px verdana, sans-serif !important;
        }

        .parameter {
            font-style: italic;
        }

        code.fsfunc {
            font: normal 16px verdana, sans-serif !important;
        }

        /* PARAMETER: This style controls spacing between the terms in Parameter section */
        dt {
            margin-top: 15px;
        }

        /* TABLES: These styles apply to all tables OTHER than the Synopsis and Example tables */
        div.refsect1 table {
            width: 100%;
			margin-top: 10px;
            background-color: #FFF;
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
			font: normal 16px verdana, sans-serif;
        }
		
        div.refsect1 th {
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
            font: bold 16px verdana, sans-serif;
        }
		
        div.refsect1 td {
            background-color: #FFF;
            padding: 5px;
            vertical-align: text-top;
			border-collapse: collapse;
			border-color: #000;
            border-width: 1px;
            font: normal 16px verdana, sans-serif;
        }
		
		  div.refsect1 p{
            font: normal 16px verdana, sans-serif;
            margin-top: 8px;
            margin-bottom: 8px;
            padding-top: 0;
            padding-bottom: 0;
        }
		

        /* EXAMPLE: These styles apply only to the Example section */
        div.refsect2 {
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 table {
            margin-top: 0;
            background-color: #e6e6e6;
            width: 100%;
            border: 0 solid #000;
            padding: 2px;
            font: normal 16px courier new, monospace !important;
        }

        div.refsect2 td {
            background-color: #e6e6e6;
            font: normal 16px courier new, monospace !important;
			white-space:pre;
        }

        /* COPYRIGHT: This style formats the text of the copyright statement at the bottom of the page */
        div.refsect3 {
            font: normal 11px verdana, sans-serif;
            margin-top: 50px;
            margin-bottom: 20px;
            padding-top: 0;
            padding-bottom: 0;
        }
					
</style>
    <title>clGetSupportedImageFormats</title>
    <meta name="generator" content="DocBook XSL Stylesheets V1.79.1" />
    <meta name="keywords" content="         &#10;                clGetSupportedImageFormats&#10;            " />
  </head>
  <body>
    <div class="refentry">
      <a id="idm1"></a>
      <div class="titlepage"></div>
      <div xmlns="" class="refnamediv">
        <a xmlns="http://www.w3.org/1999/xhtml" id="clGetSupportedImageFormats"></a>
        <h1>     
            clGetSupportedImageFormats
        </h1>
        <p>          
            Get the list of image formats supported by an OpenCL implementation.
        </p>
      </div>
      <div class="refsynopsisdiv">
        <h2></h2>
        <div class="funcsynopsis">
          <table xmlns="" border="0" summary="Function synopsis" cellspacing="0" cellpadding="0">
            <tr valign="bottom">
              <td>
                <code xmlns="http://www.w3.org/1999/xhtml" class="funcdef">
                    <a class="link" href="scalarDataTypes.html" target="_top">cl_int</a>
 <strong class="fsfunc">clGetSupportedImageFormats</strong>
                (</code>
                <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="abstractDataTypes.html" target="_top">cl_context</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">context</var>, </td>
              </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_flags" target="_top">cl_mem_flags</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">flags</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="enums.html#cl_mem_object_type" target="_top">cl_mem_object_type</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">image_type</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">num_entries</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="cl_image_format.html" target="_top">cl_image_format</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*image_formats</var>, </td>
            </tr>
            <tr valign="top">
              <td> </td>
              <td><a xmlns="http://www.w3.org/1999/xhtml" class="link" href="scalarDataTypes.html" target="_top">cl_uint</a> <var xmlns="http://www.w3.org/1999/xhtml" class="pdparam">*num_image_formats</var><code>)</code></td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="parameters"></a>
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                    <code class="varname"> 
                        context
                    </code>
                </span>
            </dt>
            <dd>
              <p> 
                        A valid OpenCL context on which the image object(s) will be created.
                    </p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname"> 
                        flags
                    </code>
                </span>
            </dt>
            <dd>
              <p> 
                        A bit-field that is used to specify allocation and usage information about the image
						memory object being created and is described in the List of supported <code class="varname">cl_mem_flags</code> values for <a class="citerefentry" href="clCreateBuffer.html"><span class="citerefentry"><span class="refentrytitle">clCreateBuffer</span></span></a>
                    </p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname">
						image_type
					</code>
                </span>
            </dt>
            <dd>
              <p> 
						Describes the image type and must be either <code class="constant">CL_MEM_OBJECT_IMAGE2D</code> or
						<code class="constant">CL_MEM_OBJECT_IMAGE3D</code>.
					</p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname">
						num_entries
					</code>
                </span>
            </dt>
            <dd>
              <p> 
						Specifies the number of entries that can be returned in the memory location given by
						<code class="varname">image_formats</code>.
					</p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname">
						image_formats
					</code>
                </span>
            </dt>
            <dd>
              <p> 
						A pointer to a memory location where the list of supported image formats are
						returned. Each entry describes a <a class="citerefentry" href="cl_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</span></span></a> structure supported by the OpenCL
						implementation. If <code class="varname">image_formats</code> is NULL, it is ignored.
					</p>
            </dd>
            <dt>
              <span class="term">
                    <code class="varname">
						num_image_formats
					</code>
                </span>
            </dt>
            <dd>
              <p>
						The actual number of supported image formats for a specific <code class="varname">context</code> and
						values specified by <code class="varname">flags</code>. If <code class="varname">num_image_formats</code> is NULL, it is ignored.			   
					</p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1">
        <a id="notes"></a>
        <h2>Notes</h2>
        <p>
			<code class="function">clGetSupportedImageFormats</code> can be used to get the list of image formats supported by an OpenCL implementation when the following information about an image memory object is specified: 
        </p>
        <div class="itemizedlist">
          <ul class="itemizedlist" style="list-style-type: disc; ">
            <li class="listitem" style="list-style-type: disc">
				Context
			</li>
            <li class="listitem" style="list-style-type: disc">
				Image type - 2D or 3D image
			</li>
            <li class="listitem" style="list-style-type: disc">
				Image object allocation information
			</li>
          </ul>
        </div>
        <p>
The minimum list of supported image formats is given by the table below:
</p>
        <div class="informaltable">
          <table class="informaltable" border="1">
            <colgroup>
              <col align="left" class="col1" />
              <col align="left" class="col2" />
              <col align="left" class="col3" />
            </colgroup>
            <thead>
              <tr>
                <th align="left">
                  <div class="literallayout">
                    <p>image_num_channels  </p>
                  </div>
                </th>
                <th align="left">
                  <div class="literallayout">
                    <p>image_channel_order  </p>
                  </div>
                </th>
                <th align="left">
                  <div class="literallayout">
                    <p>image_channel_data_type  </p>
                  </div>
                </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td align="left">
							4
                        </td>
                <td align="left">
							CL_RGBA
                        </td>
                <td align="left">
<div class="literallayout"><p><br />
CL_UNORM_INT8<br />
CL_UNORM_INT16<br />
<br />
CL_SIGNED_INT8<br />
CL_SIGNED_INT16<br />
CL_SIGNED_INT32<br />
<br />
CL_UNSIGNED_INT8<br />
CL_UNSIGNED_INT16<br />
CL_UNSIGNED_INT32<br />
<br />
CL_HALF_FLOAT<br />
CL_FLOAT<br />
</p></div>
                        </td>
              </tr>
              <tr>
                <td align="left">
4
                        </td>
                <td align="left">
CL_BGRA
                        </td>
                <td align="left">
<div class="literallayout"><p><br />
CL_UNORM_INT8<br />
</p></div>
                        </td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="errors"></a>
        <h2>Errors</h2>
        <p>
            Returns <span class="errorname">CL_SUCCESS</span> if the function is executed successfully, 
			returns <span class="errorname">CL_INVALID_CONTEXT</span> if <code class="varname">context</code> is not a valid context, returns <span class="errorname">CL_INVALID_VALUE</span>
			if <code class="varname">flags</code> or <code class="varname">image_type</code> are not valid, or if <code class="varname">num_entries</code> is 0 and <code class="varname">image_formats</code> is not NULL.
        </p>
      </div>
      <div class="refsect1">
        <a id="specification"></a>
        <h2>Specification</h2>
        <p>
            <img src="pdficon_small1.gif" />
			
				      
            <a href="http://www.khronos.org/registry/cl/specs/opencl-1.0.pdf#page=64" target="OpenCL Spec">OpenCL Specification</a>
        </p>
      </div>
      <div class="refsect1">
        <a id="seealso"></a>
        <h2>Also see</h2>
        <p>
            <a class="citerefentry" href="cl_image_format.html"><span class="citerefentry"><span class="refentrytitle">cl_image_format</span></span></a>
        </p>
      </div>
      <div xmlns="" class="refsect3" lang="en" xml:lang="en"><a xmlns="http://www.w3.org/1999/xhtml" id="Copyright"></a><h4 xmlns="http://www.w3.org/1999/xhtml"></h4><img xmlns="http://www.w3.org/1999/xhtml" src="KhronosLogo.jpg" /><p xmlns="http://www.w3.org/1999/xhtml"></p>Copyright © 2007-2009 The Khronos Group Inc. 
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be included
in all copies or substantial portions of the Materials. 
</div>
    </div>
  </body>
</html>
